GET Assets?assetTypeId={assetTypeId}&assetGroupId={assetGroupId}&parentAssetId={parentAssetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves assets for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetTypeId |
Id of the asset type |
globally unique identifier |
None. |
assetGroupId |
Id of the asset group |
globally unique identifier |
None. |
parentAssetId |
Id of the parent asset |
globally unique identifier |
None. |
take |
Number of assets to retrieve. Default is all assets |
integer |
None. |
skip |
Number of assets to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the assets before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of assets.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Asset |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "AssetId": "85199eae-f481-4ce1-bb5b-3643d3edcf95", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "9eb4ffa9-fea1-4410-b1a1-d5e933669056", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ef4e8764-d77c-4c3e-8b07-2cb550390c50", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "4b36f3c4-8318-4e5f-87d4-2546fc7bf3b7", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-06T02:06:06.5291186-07:00", "MeasurementValueNeededDate": "2024-05-06T02:06:06.5291186-07:00", "SourceSystemId": "sample string 3", "CompanyId": "40a1e55b-e983-40ea-b3de-fe1abc87d4d0", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "afd0fbed-88a0-41b7-8523-d706726579e8", "EffectiveDate": "2024-05-06T02:06:06.5291186-07:00", "StateType": { "StateTypeId": "a1f8ea83-5a28-4ad0-b087-956361352da6", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "9eb4ffa9-fea1-4410-b1a1-d5e933669056", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ef4e8764-d77c-4c3e-8b07-2cb550390c50", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "e342e43e-80df-49a9-a4ad-94f429b5927f", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "6d77f4a2-8478-43ee-99c3-97c1912e8144", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "c125b77d-9ba1-4f84-a67e-e83b41bc73a5", "EffectiveDate": "2024-05-06T02:06:06.5291186-07:00", "StatusType": { "StatusTypeId": "60ad7bcb-f9f6-46d0-b975-de5f8c62cf3a", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "9eb4ffa9-fea1-4410-b1a1-d5e933669056", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ef4e8764-d77c-4c3e-8b07-2cb550390c50", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "8dfdec75-9647-49c1-80b5-bb20f6637450", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "9a412773-0160-4c66-b849-8c0b72619d73", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "51fe5a7a-ea4c-4f59-9539-f02cfb9fb83e", "EffectiveDate": "2024-05-06T02:06:06.5291186-07:00", "WellPurposeType": { "WellPurposeTypeId": "0f3ea290-a70b-4662-a6f9-2581b6e2d2ae", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "cd006d0e-e98b-41a7-97e8-680f078464ba", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "37d31a57-eee1-42ea-9326-c52dda10895f", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-05-06T02:06:06.5291186-07:00", "MeasurementValueNeededDate": "2024-05-06T02:06:06.5291186-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "02849efc-4b24-4be5-97ee-ed6e435b931e", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 8" }, { "AssetId": "85199eae-f481-4ce1-bb5b-3643d3edcf95", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "9eb4ffa9-fea1-4410-b1a1-d5e933669056", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ef4e8764-d77c-4c3e-8b07-2cb550390c50", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "4b36f3c4-8318-4e5f-87d4-2546fc7bf3b7", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-06T02:06:06.5291186-07:00", "MeasurementValueNeededDate": "2024-05-06T02:06:06.5291186-07:00", "SourceSystemId": "sample string 3", "CompanyId": "40a1e55b-e983-40ea-b3de-fe1abc87d4d0", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "afd0fbed-88a0-41b7-8523-d706726579e8", "EffectiveDate": "2024-05-06T02:06:06.5291186-07:00", "StateType": { "StateTypeId": "a1f8ea83-5a28-4ad0-b087-956361352da6", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "9eb4ffa9-fea1-4410-b1a1-d5e933669056", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ef4e8764-d77c-4c3e-8b07-2cb550390c50", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "e342e43e-80df-49a9-a4ad-94f429b5927f", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "6d77f4a2-8478-43ee-99c3-97c1912e8144", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "c125b77d-9ba1-4f84-a67e-e83b41bc73a5", "EffectiveDate": "2024-05-06T02:06:06.5291186-07:00", "StatusType": { "StatusTypeId": "60ad7bcb-f9f6-46d0-b975-de5f8c62cf3a", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "9eb4ffa9-fea1-4410-b1a1-d5e933669056", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ef4e8764-d77c-4c3e-8b07-2cb550390c50", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "8dfdec75-9647-49c1-80b5-bb20f6637450", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "9a412773-0160-4c66-b849-8c0b72619d73", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "51fe5a7a-ea4c-4f59-9539-f02cfb9fb83e", "EffectiveDate": "2024-05-06T02:06:06.5291186-07:00", "WellPurposeType": { "WellPurposeTypeId": "0f3ea290-a70b-4662-a6f9-2581b6e2d2ae", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "cd006d0e-e98b-41a7-97e8-680f078464ba", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "37d31a57-eee1-42ea-9326-c52dda10895f", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-05-06T02:06:06.5291186-07:00", "MeasurementValueNeededDate": "2024-05-06T02:06:06.5291186-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "02849efc-4b24-4be5-97ee-ed6e435b931e", "CreateDate": "2024-05-06T02:06:06.5291186-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T02:06:06.5291186-07:00", "LastModifiedUser": "sample string 8" } ], "Total": 1, "Message": "sample string 1" }